Skip to content

Store adapter — Spree Commerce

The adapter object contains properties for connecting to the Spree Commerce API.

Parent object: a store with property "platform" : "spreecommerce"

Required properties

The following adapter properties are required for Spree Commerce stores.

token

Propertytoken
NameSpree Commerce API Token
Data typestring
Required?Yes

url

Propertyurl
NameSpree Commerce Store URL
Data typestring
Requirementsmust be valid
Required?Yes

Optional properties

The following adapter properties are optional for Spree Commerce stores.

stock_location_id

Propertystock_location_id
NameStock Location ID
Data typestring

Example

Example: create a new Spree Commerce store
curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your Spree Commerce Store",
  "platform": "spreecommerce",
  "adapter": {
    "url": "https://www.example.com",
    "token": "abc123",
    "stock_location_id": "abc123"
  }
}
EOF

For details about this request type, see: Create a new store.